Add instructions on how to build HTML from RST using sphinx-build #1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello!
💁♀️ This PR adds instructions on how to produce an HTML website based on the RST documents in the repository!
Currently, our
conf.pyis configured to use (what I think is) the base Sphinx theme. This produces a result somewhat similar to:In
README.md, we add instructions on how to use Python 3 to create a virtual environment where our dependencies are stored, install those dependencies (fromrequirements.txt) and then finally, produce the HTML site usingsphinx-build.Let me know if there are any questions around additional theming or automation and I'm glad to help!